| PRPM_HD986011ON Provider Person Search Query Response |
(Link to Excel View) Derived from RMIM: PRPM_RM986011ON |
||||||||
| RoleChoice | |||||||||
| relatedTo1 [0..2] (RelatedTo) | |||||||||
| choice of QualifiedExpertiseEntity | |||||||||
| or HealthCareProvider |
Design Comments: This roles the specific Healthcare provider role such as a Physician, Nurse or other type of caregivers. Rationale: Roleclass required to support the identification of person responsible for providing healthcare services |
||||||||
| RelatedTo | |||||||||
| typeCode [1..1] (M) RoleLink (CS) {CNE:C:RoleLinkType:REL, fixed value= "REL"} |
UsageNotes: Excluded from schemas |
||||||||
| effectiveTime [0..1] RoleLink (IVL<TS.FULLDATETIME>) |
|||||||||
| roleChoice [1..1] (RoleChoice) | |||||||||
| QualifiedExpertiseEntity | |||||||||
| classCode [1..1] (M) QualifiedEntity (CS) {CNE:C:RoleClass:QUAL, fixed value= "QUAL"} |
UsageNotes: Excluded from schemas |
||||||||
| id [0..1] QualifiedEntity (SET<II.PUBLIC>) |
Design Comments: An identifier assigned to the record of an expertise (specialty/sub-specialty) attained by a healthcare provider UsageNotes: Queried expertise identifier shall be returned. If masked, the root and extension attributes shall be replaced by a nullFlavor mask attribute. Rationale: Required attribute supports the identification of the healthcare provider. |
||||||||
| code [1..1] QualifiedEntity (CV) {CNE:D:QualifiedExpertiseRoleType} |
Design Comments: A coded value that indicates the type of expertise granted to the healthcare provider. Rationale: Allows ditinguishing different kinds of healthcare provider expertise. |
||||||||
| effectiveTime [0..1] QualifiedEntity (IVL<TS.FULLDATE>) |
Design Comments: An interval of time specifying the period during which this record in a provider registry is in effect, if such time limit is applicable and known. Rationale: Required attribute supports the identification of the healthcare provider. |
||||||||
| qualifiedPrincipalPerson [0..1] (PrincipalPerson) |
Design Comments: Identification of playing entity is required (0..1) to support the case in which information directly related to the playing party is not needed. Rationale: Provides additional information about the person playing the role of Healthcare Provider |
||||||||
| qualificationGrantingOrganization [0..1] (Organization) | |||||||||
| Inherits associations from RoleChoice | |||||||||
| PrincipalPerson [Constraint: " At least one of Healthcare Provider Role or Expertise/Credential Role must be specified "] |
Design Comments: Identification of playing entity is required (0..1) to support the case in which information directly related to the playing party is not needed. Rationale: Provides additional information about the person playing the role of Healthcare Provider |
||||||||
| classCode [1..1] (M) Person (CS) {CNE:C:EntityClass:PSN, fixed value= "PSN"} |
UsageNotes: Excluded from schemas |
||||||||
| determinerCode [1..1] (M) Person (CS) {CNE:C:EntityDeterminer:INSTANCE, fixed value= "INSTANCE"} |
UsageNotes: Excluded from schemas |
||||||||
| id [1..1] Person (II.PUBLIC) |
Design Comments: A unique identifier for the person who may play various healthcare provider roles. This identifier is specific to the person not their roles. This is the Provider Person UPI UsageNotes: Queried provider person UPI shall be returned. If masked, the root and extension attributes shall be replaced by a nullFlavor mask attribute. Rationale: Populated attribute supports the identification of the healthcare provider, and to allow for masking at the data entitlement level. |
||||||||
| name [0..1] Person (PN.BASIC) |
Design Comments: The person’s name independent of any role they may play. UsageNotes: If Principal Person is included in the message, then Person Name Must Exist. If masked, the name attribute shall be replaced by a nullFlavor mask attribute. System shall support name parts (one prefix, up to two given, one family, and one suffix). Second occurrence of given indicates the middle name. All name parts are 50 characters in length. Rationale: Populated attribute supports the identification of the healthcare provider, and to allow for masking of name at the user data entitlement level |
||||||||
| administrativeGenderCode [0..1] Person (CV) {CNE:D:AdministrativeGender} |
Design Comments: The principal person’s gender. Rationale: Required attribute supports the identification of the healthcare provider, and to allow for masking at the user data entitlement level. |
||||||||
| asARole [0..1] (ARole) | |||||||||
| asOtherIdentifier [0..1] (OtherIdentifier) | |||||||||
| languageCommunication [0..10] (LanguageCommunication) |
Design Comments: Information about what language(s) should be used to communicate with the focal person can be sent in the LanguageCommunication class. Rationale: Supports the business requirement to identify languages used by client for the purposes of communication |
||||||||
| ARole | |||||||||
| classCode [1..1] (M) Role (CS) {CNE:V:RoleClassRoot, root= "ROL"} |
|||||||||
| subjectOf [0..4] (Subject2) | |||||||||
| Subject2 | |||||||||
| typeCode [1..1] (M) Participation (CS) {CNE:C:ParticipationType:SBJ, fixed value= "SBJ"} |
|||||||||
| providerMultiplicityIndictorObservtionEvent [1..1] (ProviderMultiplicityIndictorObservtionEvent) | |||||||||
| ProviderMultiplicityIndictorObservtionEvent | |||||||||
| classCode [1..1] (M) Observation (CS) {CNE:C:ActClass:OBS, fixed value= "OBS"} |
|||||||||
| moodCode [1..1] (M) Observation (CS) {CNE:C:ActMood:EVN, fixed value= "EVN"} |
|||||||||
| code [1..1] (M) Observation (CV) {CNE:C:ActCode:ASSERTION, fixed value= "ASSERTION"} |
|||||||||
| statusCode [1..1] (M) Observation (CS) {CNE:C:ActStatus:completed, fixed value= "completed"} |
|||||||||
| value [1..1] (M) Observation (CV) {CNE:D:MultiplicityIndicatorType} |
|||||||||
| OtherIdentifier | |||||||||
| classCode [1..1] (M) Role (CS) {CNE:C:RoleClass:ROL, fixed value= "ROL"} |
UsageNotes: Excluded from schemas |
||||||||
| id [1..1] Role (II.PUBLIC) |
Design Comments: Indicates an identifier, other than professional license, assigned to the provider person by authorities other than the professional colleges. UsageNotes: The various originCode (e.g. ABH, ABH, etc) are treated as the extension (business identifier) for a generic OID root for eHO Other Identifier Issuing Organizations Queried other identifier shall be returned. If masked, the root and extension attributes shall be replaced by a nullFlavor mask attribute. Rationale: Supports positive identification of a provider person. |
||||||||
| code [1..1] Role (CV) {CNE:D:OtherIdentifierProviderRoleType} |
Design Comments: A code that indicated the type of non-license identifier assigned to the provider person. Rationale: Puts the identifier in context. |
||||||||
| effectiveTime [0..1] Role (IVL<TS.FULLDATE>) |
Design Comments: The start and end date for the other identifier. Rationale: Helps establish the validity of the identifier. |
||||||||
| scopingOtherIdentifierIssuingOrganization [0..1] (OtherIdentifierIssuingOrganization) | |||||||||
| OtherIdentifierIssuingOrganization | |||||||||
| classCode [1..1] (M) Organization (CS) {CNE:C:EntityClass:ORG, fixed value= "ORG"} |
UsageNotes: Excluded from schemas |
||||||||
| determinerCode [1..1] (M) Organization (CS) {CNE:C:EntityDeterminer:INSTANCE, fixed value= "INSTANCE"} |
UsageNotes: Excluded from schemas |
||||||||
| id [0..1] Organization (II.PUBLIC) |
Design Comments: Identifier of the organization that issued the other identifier. Rationale: Supports identification of the other identifier issuing organization. |
||||||||
| name [0..1] Organization (ST) {CNE:C:} |
Design Comments: The name of the organization issuing identifiers other than the UPI and provider licenses. Rationale: Supports identification of identifier-issuing organization. |
||||||||
| LanguageCommunication |
Design Comments: Information about what language(s) should be used to communicate with the focal person can be sent in the LanguageCommunication class. Rationale: Supports the business requirement to identify languages used by client for the purposes of communication |
||||||||
| languageCode [0..1] LanguageCommunication (CV) {CNE:D:HumanLanguage} |
Design Comments: A code indicating the language of communication Rationale: Required attribute conveying the expected language message elements are to be transmitted in |
||||||||
| Organization | |||||||||
| classCode [1..1] (M) Organization (CS) {CNE:C:EntityClass:ORG, fixed value= "ORG"} |
UsageNotes: Excluded from schemas |
||||||||
| determinerCode [1..1] (M) Organization (CS) {CNE:C:EntityDeterminer:INSTANCE, fixed value= "INSTANCE"} |
UsageNotes: Excluded from schemas |
||||||||
| id [1..1] Organization (II.PUBLIC) |
Design Comments: Identifier of the organization that issued the other identifier. Rationale: Supports identification of the other identifier issuing organization. |
||||||||
| name [1..1] Organization (ST) {CNE:C:} |
Design Comments: The name of the organization issuing identifiers other than the UPI and provider licenses. Rationale: Supports identification of identifier-issuing organization. |
||||||||
| HealthCareProvider |
Design Comments: This roles the specific Healthcare provider role such as a Physician, Nurse or other type of caregivers. Rationale: Roleclass required to support the identification of person responsible for providing healthcare services |
||||||||
| classCode [1..1] (M) LicensedEntity (CS) {CNE:C:RoleClass:PROV, fixed value= "PROV"} |
UsageNotes: Excluded from schemas |
||||||||
| id [0..1] LicensedEntity (II.PUBLIC) |
Design Comments: A unique identifier for a provider in a specific healthcare role. UsageNotes: Not in use in the current release. The root is an OID of the license issuing organization and needs to be obtained from a table IdentifierOriginSourceCode (cross-reference table of originCode and OID). The extension is the healthcare provider license number. If masked, the root and extension attributes shall be replaced by a nullFlavor mask attribute. Rationale: Supports the identification of the healthcare provider |
||||||||
| code [1..1] LicensedEntity (CV) {CNE:D:HealthCareProviderRoleType} |
Design Comments: The code identifying the specific healthcare provider role. Rationale: Populated attribute supports the identification of the healthcare provider. |
||||||||
| statusCode [0..1] LicensedEntity (CS) {CNE:V:RoleStatus} |
Design Comments: Used to indicate whether or not a provider role is active. statusCode = 'active' if the provider person is active in the role. statusCode = 'terminated' if the provider person is inactive in the role. Rationale: Required attribute supports the identification of the healthcare provider. |
||||||||
| effectiveTime [0..1] LicensedEntity (IVL<TS.FULLDATETIME>) |
Design Comments: Indicates the period (Start and End Dates) for which the rle is effective. Rationale: Supports the identification and validity of the healthcare provider role. |
||||||||
| healthCarePrincipalPerson [0..1] (PrincipalPerson) | |||||||||
| issuingOrganization [0..1] (Organization) | |||||||||
| performance [0..1] (PrimaryPerformer) | |||||||||
| relatedTo2 [0..5] (SourceOf4) | |||||||||
| Inherits associations from RoleChoice | |||||||||
| PrimaryPerformer | |||||||||
| typeCode [1..1] (M) Participation (CS) {CNE:V:ParticipationPrimaryPerformer, root= "PPRF"} |
|||||||||
| actDefinition [1..1] (ActDefinition) | |||||||||
| ActDefinition | |||||||||
| classCode [1..1] (M) Act (CS) {CNE:C:ActClass:ACT, fixed value= "ACT"} |
|||||||||
| moodCode [1..1] (M) Act (CS) {CNE:C:ActMood:DEF, fixed value= "DEF"} |
|||||||||
| location [0..1] (Location) | |||||||||
| Location | |||||||||
| typeCode [1..1] (M) Participation (CS) {CNE:C:ParticipationType:LOC, fixed value= "LOC"} |
|||||||||
| sequenceNumber [1..1] Participation (INT) |
Design Comments: Allows each Service Delivery Location to be sequentially listed. |
||||||||
| providerRoleLocation [1..1] (ProviderRoleLocation) | |||||||||
| ProviderRoleLocation | |||||||||
| classCode [1..1] (M) Role (CS) {CNE:C:RoleClass:SDLOC, fixed value= "SDLOC"} |
UsageNotes: Excluded from schemas |
||||||||
| code [0..1] Role (CV) {CNE:V:ServiceDeliveryLocationRoleType} |
Design Comments: The code identifying the specific practice (service delivery) location. UsageNotes: Always “P” – Primary in the current release of Search Response. Rationale: Assignment of code to the SDL is based on the locationRoleType from the backend. |
||||||||
| addr [1..*] Role (BAG<AD.BASIC>) |
Design Comments: Address of the specific practice (service delivery) location UsageNotes: Only city is populated. Rationale: Populated attribute supports the validation and identification of the practice address. |
||||||||
| SourceOf4 | |||||||||
| typeCode [1..1] (M) RoleLink (CS) {CNE:C:RoleLinkType:IDENT, fixed value= "IDENT"} |
UsageNotes: Excluded from schemas |
||||||||
| healthcareProviderLicensedEntity [1..1] (HealthcareProviderLicensedEntity) | |||||||||
| HealthcareProviderLicensedEntity | |||||||||
| classCode [1..1] (M) LicensedEntity (CS) {CNE:C:RoleClass:LIC, fixed value= "LIC"} |
|||||||||
| id [1..1] (M) LicensedEntity (II.PUBLIC) |
Design Comments: A unique identifier for a provider in a specific healthcare role. This is the License Certificate Number for a regulated healthcare provider. Rationale: Attribute supports the identification of a licensed healthcare provider |
||||||||
| code [0..1] LicensedEntity (CV) {CNE:V:LicenseClassificationCode} |
Design Comments: A coded value used to categorize licenses issued by specific issuing organizations. Rationale: Supports role-based acces and permissions to be assigned at higher levels than the atomic healthcare provider role. |
||||||||
| statusCode [0..1] LicensedEntity (CS) {CNE:V:RoleStatus} |
|||||||||
| effectiveTime [0..1] LicensedEntity (IVL<TS.FULLDATE>) |
Design Comments: Indicates the start and end date for the license certificate. Rationale: Required attribute to support the validity of the license. |
||||||||
| issuingOrganization [0..1] (Organization) | |||||||||
| responsibleFor [0..100] (ResponsibleParty) | |||||||||
| ResponsibleParty | |||||||||
| typeCode [1..1] (M) Participation (CS) {CNE:C:ParticipationType:RESP, fixed value= "RESP"} |
|||||||||
| restriction [1..1] (Restriction) | |||||||||
| Restriction | |||||||||
| classCode [1..1] (M) Act (CS) {CNE:C:ActClass:ACT, fixed value= "ACT"} |
UsageNotes: Excluded from schemas |
||||||||
| moodCode [1..1] (M) Act (CS) {CNE:C:ActMood:PERM, fixed value= "PERM"} |
UsageNotes: Excluded from schemas |
||||||||
| id [0..1] Act (II.BUS) |
Design Comments: Unique identifier for the restriction. Rationale: Required attribute supports the validation and identification of the healthcare provider and his/her given privileges |
||||||||
| code [1..1] (M) Act (CV) {CNE:D:RestrictionToPracticeType} |
Design Comments: Type of restriction. Rationale: Mandatory attribute supports the nature of the restriction. |
||||||||
| negationInd [1..1] (M) Act (BL){fixed value= "true"} |
Design Comments: Indicating that the privilege is a restriction. Rationale: Mandatory attribute supports the notion that the information pertains to a retriction placed on a provider's license. |
||||||||
| text [0..1] Act (ST) {CNE:C:} |
Design Comments: Comments and/or detailed description pertaining to the nature of the restriction. In some cases this will be a link to a web page that provides details of the restriction or limitation. UsageNotes: In the current release this element is populated only for Provider Details. Rationale: Required attribute supports the validation and identification of the healthcare provider and the nature of restriction placed on the provider's license. |
||||||||
| effectiveTime [0..1] Act (IVL<TS.FULLDATE>) |
Design Comments: Effective date of the restriction. UsageNotes: If Restrictions to Practice are included in the message, then Effective Date Must Exist Rationale: Required attribute supports the validation and identification of the healthcare provider and his/her given privileges |
||||||||
| confidentialityCode [0..1] Act (CV) {CNE:V:X_VeryBasicConfidentialityKind} |
Design Comments: Indicates the degree to which the restriction to practice is to be kept confidential. UsageNotes: Not in use in the current release. Rationale: Required attribute supports the validation and identification of the healthcare provider and the extent of confidentiality of the restriction information. |
||||||||